/*
 * Copyright (C) 2020 Grakn Labs
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

package grakn.core.graph.diskstorage.log;

/**
 * Implementations of this interface are used to process messages read from the LOG.
 *
 */
public interface MessageReader {

    /**
     * Processes the given message. The message object may not be mutated!
     */
    void read(Message message);

    /**
     * Updates the state of the MessageReader.
     */
    void updateState();

    /**
     * Need to override this method because the Log uses this comparison
     * when un-registering readers
     *
     * @param other other reader to compare against
     */
    @Override
    boolean equals(Object other);

}
